home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / ndscn110.arc / NODESCAN.DOC < prev    next >
Text File  |  1991-02-04  |  9KB  |  245 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.          ***    **            **
  7.          ****   **            **
  8.          ** **  **  ****   *****   ****   ****  *****  ***   **
  9.          **  ** ** **  ** **  **  **  ** **    **        **  *****
  10.          **   **** **  ** **  **  ****** ****  **      ****  ** **
  11.          **    *** **  ** **  **  **        ** **     ** **  ** **
  12.          **     **  ****   ******  ****  ****   *****  ***** ** **
  13.  
  14.  
  15.                                   Version 1.1
  16.  
  17.  
  18.                               Copyright (C) 1990
  19.  
  20.                                by Michel Renaud
  21.  
  22.                              Hull, Québec, Canada
  23.  
  24.                              FidoNet  1:163/211.6
  25.  
  26.                             DISCLAIMER OF WARRANTY
  27.                             ======================
  28.  
  29.     There  is  only  one  guarantee: Nodescan works fine on MY computer.  I
  30.     will not be held responsible  for  any  problems/damages  Nodescan  may
  31.     cause on your system.  USE AT YOUR OWN RISK.
  32.  
  33.  
  34.                                    FREEWARE
  35.                                    ========
  36.  
  37.     This  program  is  FREEWARE.  First, that means it is FREE.  You should
  38.     not charge for the distribution or use of Nodescan.  Second, it  should
  39.     be  distributed  in  its  original  form,  that is, the executable file
  40.     NODESCAN.EXE and the documentation (NODESCAN.DOC).  Third, the  program
  41.     should not be modified in any way.
  42.  
  43.                                  INTRODUCTION
  44.                                  ============
  45.  
  46.     Nodescan  reads  an  AREAS.BBS-type file and output the total number of
  47.     addresses and echos listed into it.  It will also output the number  of
  48.     echos for each address and the total number of single feeds (echos with
  49.     only one node listed).
  50.  
  51.     The idea comes from Ken Wilson, the Region 12 EchoMail Co-ordinator and
  52.     SysOp of the Ned's Opus Bulletin Board in Ottawa,  Ontario,  Canada.  I
  53.     originally  wrote the utility with only Ken's REC system in mind, but a
  54.     few days after its release on SDS, bug  reports  and  suggestions  came
  55.     from  a couple of sysop in North America and Europe.  I then decided to
  56.     go on and write some documentation, and add a few  options  to  support
  57.     other zones and short forms of areas file.
  58.  
  59.     This  program  is FREEWARE.  You may not charge for its distribution or
  60.     use.  I do not expect any money from you.  Either you like  it  or  you
  61.     hate  it.   In  either case, I would like to hear from you, just for my
  62.     own satisfaction :-)
  63.  
  64.     Nodescan  was written using Turbo C++ 1.0 (in ANSI C mode) from Borland
  65.     International.  The CXL v5.2 library  by  Mike  Smedley  was  used  for
  66.     string handling.
  67.  
  68.  
  69.                             BUG REPORTS/SUGGESTIONS
  70.                             =======================
  71.  
  72.     If you experience any problem with Nodescan, you can always write to me
  73.     via  FidoNet  netmail  at  1:163/211.6.   I  will  do my best to find a
  74.     solution  to  your  problem.   Please   include   any   system-specific
  75.     information  you  may find useful.  A copy of your AREAS.BBS file would
  76.     help me too.
  77.  
  78.     Any suggestions may also be sent to 1:163/211.6.
  79.  
  80.     Keep  in mind that I work on Nodescan on my spare time only.  I will do
  81.     my  best  to   enhance   or   fix   Nodescan,   but   do   not   expect
  82.     commercial-quality service from me.
  83.  
  84.                                 USING NODESCAN
  85.                                 ==============
  86.  
  87.     Nodescan  is  very  simple  to use.  The only required parameter is the
  88.     filename of an AREAS.BBS-type file.  You may add  other  parameters  to
  89.     specify the sort method to be used and the default zone number.
  90.  
  91.     Syntax:
  92.     =======
  93.  
  94.         NODESCAN <filename> [/a /e /n] [/z:<zone>] [/q] [/? /H]
  95.  
  96.     where:
  97.  
  98.         <filename>  is  the  filename of the areas file to be scanned.  You
  99.         may enter  only  the  filename  if  the  file  is  in  the  current
  100.         directory, or a full pathname.  This parameter is required.
  101.  
  102.         /a to sort the output list by address.
  103.  
  104.         /e to sort the output list by number of echos.
  105.  
  106.         /n no sort.
  107.  
  108.         /z:<zone>  specify  the zone number.  The default zone number is 1.
  109.         If you were in zone 2 you would enter /Z:2
  110.  
  111.         /q   quiet  mode.   Suppresses  the  display  of  "Reading..."  and
  112.         "Sorting..." messages.
  113.  
  114.         /? and /H display the help screen.
  115.  
  116.  
  117.     Nodescan will only accept one parameter of each type.  That is, if  you
  118.     enter:
  119.  
  120.         NODESCAN areas.bbs /a /e /z:2 /z:1
  121.  
  122.     Nodescan will ignore the /e and /z:1.
  123.  
  124.     Nodescan will also ignore incorrect parameters, as long as the required
  125.     parameter (the filename) is specified.
  126.  
  127.  
  128.                               PRINTING THE OUTPUT
  129.                               ===================
  130.  
  131.     You  can  use  the  MS-DOS  output  redirection  operator  (>)  to send
  132.     Nodescan's output to a disk file or to the printer.
  133.  
  134.     eg.
  135.                 NODESCAN areas.bbs>prn
  136.                 NODESCAN areas.bbs>nodescan.out
  137.  
  138.  
  139.     While  processing  a  file,  Nodescan  displays  the  messages  "Reading
  140.     <filename>" and "Sorting".  They are being sent to stderr, that is, the
  141.     screen.  Redirected output will not contain these messages.
  142.  
  143.  
  144.                                   LIMITATIONS
  145.                                   ===========
  146.  
  147.     Nodescan currently have the following limitations:
  148.  
  149.         -  The maximum number of different addresses that can be handled is
  150.            256.
  151.  
  152.         -  The maximum line length in AREAS.BBS is 512 characters.
  153.  
  154.     A future release of Nodescan will allocate memory  dynamically,  making
  155.     the  maximum  number of addresses limited only by available memory (and
  156.     reducing the memory requirements if you have less  than  256  nodes  in
  157.     your AREAS.BBS).
  158.  
  159.  
  160.                           NOTES ABOUT YOUR AREAS.BBS
  161.                           ==========================
  162.  
  163.     Nodescan  will  handle  the  long  and  short forms of AREAS.BBS files.
  164.     Nodescan assumes the following about your file:
  165.  
  166.         - the system and sysop name are on the first line of the  file  and
  167.         are separated by an exclamation mark (!).
  168.  
  169.         - the system name is no longer than 128 characters.
  170.  
  171.         - the sysop name is no longer than 128 characters.
  172.  
  173.         - ignores lines starting with a '-' or ';'
  174.  
  175.         - assumes  that a line containing a '/' contains at least one valid
  176.         address and will process this line (except if the line starts  with
  177.         '-' or ';').
  178.  
  179.         -  assumes  that  you  don't have any address longer than something
  180.         like "1:50000/50000".
  181.  
  182.  
  183.                                     HISTORY
  184.                                     =======
  185.  
  186.     10/05/90  version 1.1
  187.  
  188.         - Added documentation.
  189.  
  190.         - Corrected two bugs in the sort routines:
  191.  
  192.                 -  it  would  hang  the machine if the areas file contained
  193.                 addresees with more than 10 characters (eg.   1:1111/1111).
  194.                 This  has  been fixed and Nodescan can now handle addresses
  195.                 containing up to 13 characters (see LIMITATIONS).
  196.  
  197.                 - the address sort wasn't sorting properly.
  198.  
  199.         - Added support for short form files.
  200.  
  201.         - Added support for zones.
  202.  
  203.         - Maximum number of addresses increased from 128 to 256.
  204.  
  205.         - Added output of total single feeds in the file.
  206.  
  207.  
  208.     09/10/90    Version 1.00
  209.  
  210.         Initial release.
  211.  
  212.  
  213.                                     CREDITS
  214.                                     =======
  215.  
  216.     I  would  like  to  thank  the  following  people  who  helped  in  the
  217.     development of Nodescan:
  218.  
  219.         - Ken Wilson (1:163/211) who came up with  the  original  idea  and
  220.         then suggested a few additions to the  initial  release.   Nodescan
  221.         would not exist without him.
  222.  
  223.         -   George  Peace  (1:13/13) was the first person to bring the sort
  224.         problem to my attention.
  225.  
  226.         - John Burden (2:255/1) who confirmed that the sort routine  had  a
  227.         real  problem <grin>.  Without this guy Nodescan would probably not
  228.         support short form areas file and zone numbers.
  229.  
  230.         - Did I forget someone? :-)
  231.  
  232.  
  233.                                 FUTURE RELEASES
  234.                                 ===============
  235.  
  236.     I plan to modify the program to allocate  memory  dynamically  using  a
  237.     linked  list  instead  of  a  static array.  This will make the maximum
  238.     number of addresses limited only by available memory,  and  reduce  the
  239.     memory requirements for those of you who have small areas file.
  240.  
  241.     Better handling of printer output.  Page headers and page numbers, that
  242.     kind of stuff.
  243.  
  244.     Any suggestions are welcome... netmail to 1:163/211.6
  245.